/*
 * Tencent is pleased to support the open source community by making BK-CI 蓝鲸持续集成平台 available.
 *
 * Copyright (C) 2019 Tencent.  All rights reserved.
 *
 * BK-CI 蓝鲸持续集成平台 is licensed under the MIT license.
 *
 * A copy of the MIT License is included in this file.
 *
 *
 * Terms of the MIT License:
 * ---------------------------------------------------
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of
 * the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
 * LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
 * NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

package com.tencent.devops.repository.api.scm

import com.tencent.devops.common.api.auth.AUTH_HEADER_USER_ID
import com.tencent.devops.common.api.pojo.Result
import io.swagger.v3.oas.annotations.Operation
import io.swagger.v3.oas.annotations.Parameter
import io.swagger.v3.oas.annotations.tags.Tag
import jakarta.ws.rs.Consumes
import jakarta.ws.rs.DefaultValue
import jakarta.ws.rs.GET
import jakarta.ws.rs.HeaderParam
import jakarta.ws.rs.Path
import jakarta.ws.rs.Produces
import jakarta.ws.rs.QueryParam
import jakarta.ws.rs.core.MediaType

@Tag(name = "USER_GIT_OAUTH_OPERATIONS", description = "用户代码库提交信息查询等功能")
@Path("/user/git/")
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
interface UserGitRepositoryResource {

    @Operation(summary = "根据分支获取代码库最近提交信息")
    @GET
    @Path("/commitMessages/get")
    fun getRecentGitCommitMessages(
        @Parameter(description = "userId", required = true)
        @HeaderParam(AUTH_HEADER_USER_ID)
        userId: String,
        @Parameter(description = "分支", required = false)
        @QueryParam("branch")
        branch: String?,
        @Parameter(description = "代码库链接", required = false)
        @QueryParam("codeSrc")
        codeSrc: String?,
        @Parameter(description = "gitProjectId", required = false)
        @QueryParam("gitProjectId")
        gitProjectId: Long? = null,
        @Parameter(description = "获取提交信息数量(默认读取最近5条)", required = false)
        @QueryParam("commitNumber")
        @DefaultValue("5")
        commitNumber: Int,
        @Parameter(description = "需要过滤的前缀列表（逗号分隔,空值表示不过滤）", required = false)
        @QueryParam("prefixes")
        @DefaultValue("Merge")
        prefixes: String?,
        @Parameter(description = "需要过滤的关键词列表（逗号分隔,空值表示不过滤）", required = false)
        @QueryParam("keywords")
        keywords: String?
    ): Result<String>
}
